home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / mult_edi.arc / ACI_HYPE.HLP next >
Text File  |  1989-10-21  |  7KB  |  185 lines
  1. @ME.FORMAT                                                               R                                                 
  2. * INTRO TO ACI HYPERTEXT
  3. Welcome to the ^BAmerican Cybernetics' Hypertext System^b (ACI Hypertext).
  4.  
  5.     @QUICKREF[!A. Quick reference to ACI Hypertext]
  6.     @SEARCH[!B. Searching for text]
  7.     @FORMAT[!D. ACI Hypertext file format]
  8.     @INDEXGEN[!E. Using the Index Generator for FAST access]
  9. QUICKREF ACI HYPERTEXT QUICK REFERENCE
  10. <ENTER>        Select current link
  11. <BackSpace>    Move to previously selected chapter.
  12. <ESC>        Exit help system
  13.  
  14. <UP>, <DOWN>
  15. <LEFT>, <RIGHT> Moves the cursor between the highlighted links.
  16.  
  17. <PgUp>        Move one screen up.        <Gray+>  Scroll up.
  18. <PgDn>        Move one screen down.        <Gray->  Scroll down.
  19.  
  20. <CtrlUP>, <CtrlDOWN>      Scroll chapter up and down.
  21. <CtrlLEFT>, <CtrlRIGHT> Scroll chapter left and right.
  22.  
  23. <F1>        Bring up table of contents for the current hypertext file.
  24. <F5>        Returns to the last-displayed help screen of the previous
  25.         help session.
  26. <F6>        Search current chapter for a string.
  27. <CtrlF6>    Repeat previous search
  28. <AltF6>        Search file.
  29.  
  30. FORMAT ACI Hypertext File Format
  31.  
  32. An ACI Hypertext file is basically a straight ASCII text file with some simple
  33. codes imbedded in it to define chapters, links and attributes.
  34.  
  35.     @CHAPTERS[!A.  Chapter definitions]
  36.     @LINKS[!B.  Link definitions]
  37.     @QUICKKEYS[!C.  Link Quick-Keys]
  38.     @TOFILES[!D.  Linking to other files]
  39.     @TOPROG[!E.  Linking to other programs]
  40.     @ATTRIBS[!F.  Screen Attributes]
  41.  
  42.  
  43. NOTE:  The best way to learn the file format is probably to load this file
  44.        (ACI_HYPE.HLP) into a new window and look at it in its `raw' form.
  45. CHAPTERS ACI Hypertext File Format - Chapter Definitions
  46.  
  47. Chapters are preceded by a chapter header, which consists of a form feed
  48. (ASCII 12) character in column 1, followed immediately (no space) by an
  49. index string which may be up to 20 characters long.  This is the key
  50. that is referenced by @LINKS[links].  Separated from the index string by
  51. a space character is the chapter title.  It may be up to 80 characters
  52. long.
  53.  
  54. LINKS ACI Hypertext File Format - Link Definitions
  55.  
  56. A @CHAPTERS[chapter] may be indexed anywhere in the file by defining a "link".  To
  57. define a link you specify the index with an"@@" character and then mark the
  58. text to be highlighted with square brackets: @@index[highlighted text]
  59.  
  60.     Example:    @@FORMAT[ACI Hypertext Format]
  61.  
  62. To enter in an "@@" character literally (like we are doing here), you put
  63. it in twice (i.e. "@@@@").
  64.  
  65. The following characters may NOT be used in the index name of a link:
  66.  
  67.                 @@
  68.                 [
  69.             ]
  70.                     !
  71.                     ^^
  72.                     %
  73.                     Form Feed (ASCII 12) character
  74.  
  75. These characters are reserved for other functions.
  76.  
  77. You may use the "!" character to specify a @QUICKKEYS[quick-key] for the link.
  78.  
  79. See also @TOFILES[Linking into other files] and @INDXSRCH[Linking with Search]
  80. INDXSRCH ACI Hypertext File Format - Linking with Search
  81.  
  82. You may specify a search string along with the link.  When this link is selected,
  83. the specified chapter will be brought up and the first occurrence of the search
  84. string will be highlighted: @@index%search_string[highlighted text]
  85.  
  86.     Example:
  87.  
  88.         ^B@@HYPE.HLP^INDXSRCH%LINK[First Occurrence of LINK]^b
  89.  
  90.         This example would bring up this chapter and highlight the
  91.         first occurrence of "LINK".
  92.  
  93. NOTE:    The search is NOT case sensitive, and @SEARCH[Next Search] may be used
  94.     to search for the next occurrence of the search string.
  95.  
  96. QUICKKEYS ACI Hypertext File Format - Link Quick-Keys
  97.  
  98. An "!" may be used as the first character of the highlighted text in order
  99. to specify an index letter.  This allows you to set up a menu, where the
  100. first letter of the highlighted text can be used to select that link.
  101.  
  102.     Example:    @@BASIC_USE[!A. How to use ACI Hypertext]
  103.             @@FORMAT[!B. Hypertext document format]
  104.             @@JOKES[!C. Jokes]
  105. TOFILES ACI Hypertext File Format - Linking into other files
  106.  
  107. You may optionally specify a file name in the link.  The format is:
  108.  
  109.             @@filename^^index[highlighted text]
  110.  
  111. This will cause ACI Hypertext to bring up the specified file and search for the
  112. index.
  113. TOPROG ACIHELP File Format - Linking to other programs
  114.  
  115. To run another program (using COMMAND.COM) the format is:
  116.  
  117.         @@<command_line[highlighted text]
  118.  
  119. Upon completion of the program, the screen will be restored, and ACI Hypertext
  120. will return to the same position in the hypertext file.
  121. ATTRIBS ACI Hypertext File Format - Screen Attributes
  122.  
  123. Sections of text other than links may be highlighted, bolded or assigned other
  124. attributes.  This is done by inserting codes that begin with a ^B^^^b.  The
  125. following attributes are available:
  126.  
  127.     ^BBold on^0        ^B^^B^b        Bold off    ^B^^b^b
  128.     ^RReverse on^0    ^B^^R^b        (use ^B^^R^b again to turn reverse off).
  129.     ^KBlink on^0    ^B^^K^b        Blink off    ^B^^k^b
  130.  
  131.     Normal text    ^B^^0^b
  132.     ^1Text color 1^0    ^B^^1^b
  133.     ^2Text color 2^0    ^B^^2^b
  134.     ^3Text color 3^0    ^B^^3^b
  135.  
  136. Examples:
  137.     This is ^^Rreverse video^^R and this isn't.
  138.     This is ^Rreverse video^R and this isn't.
  139.  
  140.     This is ^^B^^Kbold and blinking^^k and this is just bold^^b.
  141.     This is ^B^Kbold and blinking^k and this is just bold^b.
  142.  
  143.     This is ^^1color 1^^0 and this isn't.
  144.     This is ^1color 1^0 and this isn't.
  145.  
  146.     To embed a ^B^^^b in a file, just put it in twice.
  147.  
  148. See also @FORMAT[ACI Hypertext File Format].
  149. INDEXGEN INDEXGEN The ACI Hypertext Index Generator
  150.  
  151. ACI Hypertext will work with or without an index file.  For small hypertext
  152. files you probably won't be able to tell the difference between an
  153. indexed and a non-indexed file.  However, for large hypertext files,
  154. where access time is starting to be a problem, an index file becomes
  155. very important.
  156.  
  157. ACI Hypertext automatically looks for an index file for the hypertext file it
  158. is working with.  It makes the assumption that the index file will have
  159. the same name and be in the same directory as the hypertext file, but
  160. that it will have the extension ".NDX".  If the ".NDX" file is not found
  161. then ACI Hypertext goes on just fine without it.
  162.  
  163. Generating an index file for an ACI Hypertext file is very easy.
  164. Just type (at the DOS command line) "INDEXGEN filename".  The filename
  165. must include the extension.  For example "INDEXGEN ACI_HYPE.HLP" would
  166. create a file called "ACI_HYPE.NDX".
  167.  
  168. ACI Hypertext automatically compares the time/date stamp of the index file and
  169. the hypertext file.  If the index file is older than the hypertext file,
  170. then the index file will NOT be used.
  171.  
  172. SEARCH Searching for Text
  173. You may search for text in the current chapter or file, and you may repeat the
  174. last search operation.
  175.  
  176. To search for text in the current chapter, hit the key assigned to
  177. Chapter Search (see @QUICKREF%SEARCH[Quick Reference] for key assignments).
  178. Type in the desired search string at the prompt and then hit <ENTER>.  The
  179. first occurrence of the search string will be highlighted.
  180.  
  181. To search for text in the entire file, hit the key assigned to File Search
  182. (see @QUICKREF%Search file[Quick Reference]), and repeat the steps for Chapter
  183. Search.
  184.  
  185. To repeat your last search operation, select Next Search